Skip to content

Contributing guide#1565

Draft
jochenklar wants to merge 9 commits into
mainfrom
contributing-guide
Draft

Contributing guide#1565
jochenklar wants to merge 9 commits into
mainfrom
contributing-guide

Conversation

@jochenklar
Copy link
Copy Markdown
Member

@jochenklar jochenklar commented Mar 20, 2026

This PR adds/updates 5 documents to the repo:

  • CONTRIBUTING.md contains the guidelines for contributors how we work.
  • ARCHITECTURE.md aims to explain the structure of the repository, file naming conventions and external and internal dependencies.
  • STYLE.md collects naming conventions, code patterns and ux/ui considerations.
  • (edit 2026-05-05) CODE_OF_CONDUCT.md our code of conduct.
  • (edit 2026-05-05) SECURITY.md.

I will present the documents at the community meeting and we will have a review process with the community. While afterwards CONTRIBUTING.md is meant to be more or less stable, I expect the other two documents to be updated more frequently.

Direct links for convenience:

@jochenklar jochenklar self-assigned this Mar 20, 2026
Comment thread ARCHITECTURE.md Outdated
Comment thread STYLE.md Outdated
Comment thread STYLE.md Outdated
Comment thread STYLE.md Outdated
Comment thread STYLE.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread STYLE.md Outdated
Comment thread STYLE.md Outdated
@CalamityC CalamityC mentioned this pull request Mar 25, 2026
@afuetterer
Copy link
Copy Markdown
Member

This PR adds 3 documents to the repo:

* `CONTRIBUTING.md` contains the guidelines for contributors how we work.

* `ARCHITECTURE.md` aims to explain the structure of the repository, file naming conventions and external and internal dependencies.

* `STYLE.md` collects naming conventions, code patterns and ux/ui considerations.

Just for the record I would like to clarify: There has been a contributor guide in this repo since 2018. This PR updates the guide.

@afuetterer
Copy link
Copy Markdown
Member

Question: Is this repo the best place for these documents? Should they apply to plugins as well? Would a central place, like the docs, make more sense?

@jochenklar
Copy link
Copy Markdown
Member Author

@afuetterer yes, CONTRIBUTING.md is actually updated, sorry for the confusion.

My idea was that this repo is actually the place where people would look. I expect that ARCHITECTURE.md and STYLE.md evolve with the code and CONTRIBUTING.md remains static. The plan is also that the general assembly of RDMO votes on it, so that is is more official.

We follow KITODO here: https://github.com/UB-Mannheim/kitodo-coding-guidelines.

Comment thread STYLE.md Outdated
Comment thread CONTRIBUTING.md Outdated
@jochenklar
Copy link
Copy Markdown
Member Author

I implemented all requested changes (I think ...), added a SECURITY.md, and updated the CODE_OF_CONDUCT.md a bit: Mostly about the new Verein, but I also added a paragraph adding a scope:

This Code of Conduct applies within all spaces maintained by the RDMO. Research Data Management Organiser e.V. ("RDMO e.V."), including the GitHub organization at https://github.com/rdmorganiser, the RDMO mailing list, the RDMO Matrix space, and any other communication channels operated on behalf of the community. It also applies when an individual is representing the community in public spaces.

I hope that is ok for everybody.

@CalamityC
Copy link
Copy Markdown
Collaborator

Still found one typo in STYLE.md line 105:
An exception are fields in models, ...
It should read
"An exception are fields in modals, ..."

Comment thread ARCHITECTURE.md Outdated

* `core` does not depend on the other modules.
* `accounts` does only depend on `core`.
* `conditions`, `domain`, `options`, `questions`, `tasks`, `views` depend only on `core` (with the exception that the `options.Optionset` model and the `conditions.Condition` depend on each other).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and what about these?

  • conditions.Condition depends on Attribute and Option
  • questions.Question depends on Condition, Attribute, OptionSet
  • questions.QuestionSet depends on Condition and Attribute
  • questions.Page depends on Condition and Attribute

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I add those relations, but more general, on the model level. I also removed the plot since it was misleading and I could not come up with a non confusing one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants